SpringBoot RESTful ExceptionHandler

SpringBoot：1.5.10.RELEASE

Spring Framework 提供了 @ExceptionHandler 注解用于异常处理。

定义自定义异常：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

public class BaseCustomExcpetion extends RuntimeException {
	
	public BaseCustomExcpetion(String message) {
		super(message);
	}
	
}

public class CustomBizExceptionOne extends BaseCustomExcpetion {
	
	public CustomBizExceptionOne(String message) {
		super(message);
	}
}

public class CustomBizExceptionTwo extends BaseCustomExcpetion {
	
	public CustomBizExceptionTwo(String message) {
		super(message);
	}
}

public class CustomBizExceptionThree extends BaseCustomExcpetion {
	
	public CustomBizExceptionThree(String message) {
		super(message);
	}
}

定义在 Controller 内部

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@RequestMapping("/demo01")
@RestController
public class Demo01Controller {
	
	@GetMapping("/test01")
	public String test01() {
		throw new CustomBizExceptionThree("测试 抛出 业务异常 CustomBizExceptionThree");
	}
	
	@ExceptionHandler(CustomBizExceptionThree.class)
	@ResponseBody
	public String controllerInnerExceptionHandler(Exception e) {
		return "Demo01Controller " + e.getMessage();
	}
	
}

定义在 Controller 只能处理 Controller 内部产生的异常

定义在 BaseController 基类中

为了复用，可以将其定义在 BaseController 基类中，任何一个 Controller 只要继承 BaseController 即可。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
import com.example.exception.BaseCustomExcpetion;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

public class BaseController {
	
	@ExceptionHandler(NullPointerException.class)
	@ResponseBody
	public String controllerNullPointerExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(RuntimeException.class)
	@ResponseBody
	public String controllerRuntimeExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(BaseCustomExcpetion.class)
	@ResponseBody
	public String controllerBaseCustomExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(Exception.class)
	@ResponseBody
	public String controllerExceptionHandler(Exception e) {
		return e.getMessage();
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
import com.example.exception.BaseCustomExcpetion;
import com.example.exception.CustomBizExceptionOne;
import com.example.exception.CustomBizExceptionTwo;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/demo02")
@RestController
public class Demo02Controller extends BaseController {
	
	@GetMapping("/test01")
	public String test01() {
		throw new BaseCustomExcpetion("测试 直接 抛出 BaseCustomException");
	}
	
	@GetMapping("/test02")
	public String test02() {
		throw new CustomBizExceptionOne("测试 抛出 业务异常 CustomBizExceptionOne");
	}
	
	@GetMapping("/test03")
	public String test03() {
		throw new CustomBizExceptionTwo("测试 抛出 业务异常 CustomBizExceptionTwo");
	}
	
	@GetMapping("/test04")
	public String test04() {
		throw new RuntimeException("测试 抛出 RuntimeException");
	}
	
	@GetMapping("/test05")
	public String test05() {
		throw new NullPointerException("测试 抛出 NullPointerException");
	}
	
}

定义在接口中

为了减少单继承的影响，将其定义在接口中，利用 JDK8 default 新特性。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
import com.example.exception.BaseCustomExcpetion;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

public interface ControllerExceptionHandler {
	
	@ExceptionHandler(NullPointerException.class)
	@ResponseBody
	default String controllerNullPointerExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(RuntimeException.class)
	@ResponseBody
	default String controllerRuntimeExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(BaseCustomExcpetion.class)
	@ResponseBody
	default String controllerBaseCustomExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(Exception.class)
	@ResponseBody
	default String controllerExceptionHandler(Exception e) {
		return e.getMessage();
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
import com.example.exception.BaseCustomExcpetion;
import com.example.exception.CustomBizExceptionOne;
import com.example.exception.CustomBizExceptionTwo;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/demo04")
@RestController
public class Demo04Controller {
	
	@GetMapping("/test01")
	public String test01() {
		throw new BaseCustomExcpetion("测试 直接 抛出 BaseCustomException");
	}
	
	@GetMapping("/test02")
	public String test02() {
		throw new CustomBizExceptionOne("测试 抛出 业务异常 CustomBizExceptionOne");
	}
	
	@GetMapping("/test03")
	public String test03() {
		throw new CustomBizExceptionTwo("测试 抛出 业务异常 CustomBizExceptionTwo");
	}
	
	@GetMapping("/test04")
	public String test04() {
		throw new RuntimeException("测试 抛出 RuntimeException");
	}
	
	@GetMapping("/test05")
	public String test05() {
		throw new NullPointerException("测试 抛出 NullPointerException");
	}
	
	
}

使用 @ControllerAdvice 全局拦截

使用 @ControllerAdvice 全局拦截可以更简便。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import com.example.exception.BaseCustomExcpetion;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class GlobalExceptionHandler {
	
	@ExceptionHandler(NullPointerException.class)
	@ResponseBody
	public String controllerNullPointerExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(RuntimeException.class)
	@ResponseBody
	public String controllerRuntimeExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(BaseCustomExcpetion.class)
	@ResponseBody
	public String controllerBaseCustomExceptionHandler(Exception e) {
		return e.getMessage();
	}
	
	@ExceptionHandler(Exception.class)
	@ResponseBody
	public String controllerExceptionHandler(Exception e) {
		return e.getMessage();
	}
}

当然了也可以将 GlobalExceptionHandler 结合 JDK 8 接口 default 特性。

Controller 内能处理的优先处理

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import com.example.exception.BaseCustomExcpetion;
import com.example.exception.CustomBizExceptionOne;
import com.example.exception.CustomBizExceptionTwo;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/demo05")
@RestController
public class Demo05Controller {
	
	@GetMapping("/test01")
	public String test01() {
		throw new BaseCustomExcpetion("测试 直接 抛出 BaseCustomException");
	}
	
	@GetMapping("/test02")
	public String test02() {
		throw new CustomBizExceptionOne("测试 抛出 业务异常 CustomBizExceptionOne");
	}
	
	@GetMapping("/test03")
	public String test03() {
		throw new CustomBizExceptionTwo("测试 抛出 业务异常 CustomBizExceptionTwo");
	}
	
	@GetMapping("/test04")
	public String test04() {
		throw new RuntimeException("测试 抛出 RuntimeException");
	}
	
	@GetMapping("/test05")
	public String test05() {
		throw new NullPointerException("测试 抛出 NullPointerException");
	}
	
	@ExceptionHandler(BaseCustomExcpetion.class)
	@ResponseBody
	public String controllerBaseCustomExceptionHandler(Exception e) {
		return "Demo05Controller " + e.getMessage();
	}
}

代码详见GitHub 上
example-boot/example-exception-handler

赏

谢谢你请我吃糖果

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

很惭愧<br><br>只做了一点微小的工作<br>谢谢大家